Alauda Build of SonarQube Docs
  • 简体中文

    • SonarQube

    描述
    Sonarqube is the Schema for the sonarqubes API
    类型
    object

    规格

    属性类型描述
    apiVersionstring

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

    kindstring

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

    metadataObjectMeta

    ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

    specobject

    Spec describes the state of the sonarqube instance

    statusobject

    Status describes the status of the sonarqube instance

    .spec

    描述
    Spec describes the state of the sonarqube instance
    类型
    object
    属性类型描述
    externalURLstring

    When the Service Type is "NodePort", please enter http://IP:port, and the "port" must be the same as the Service's Node Port

    When the Service Type is "Ingress", please enter the corresponding access address, for example: http://kubernetes.io.

    helmValuesobject

    HelmValues specify custom configuration witch the helm chart supported

    versionstring

    Version specify the tool version which want to install

    .spec.helmValues

    描述
    HelmValues specify custom configuration witch the helm chart supported
    类型
    object

    .status

    描述
    Status describes the status of the sonarqube instance
    类型
    object
    属性类型描述
    availableUpgradableVersionsarray

    list all available upgradable versions

    conditionsarray
    configurationstring
    currentVersionstring

    support auto upgrade version

    dependency_secretsarray
    deployedReleaseobject
    externalURLstring
    helmValuesobject

    record helm values

    targetVersionstring

    .status.availableUpgradableVersions

    描述
    list all available upgradable versions
    类型
    array

    .status.availableUpgradableVersions[]

    描述
    UpgradableChartVersion is used to record the upgradable version of the chart include the links to the upgrade guide
    类型
    object
    属性类型描述
    appVersionstring
    descriptionstring
    linksarray

    Links is the links to the upgrade guide

    描述
    Links is the links to the upgrade guide
    类型
    array
    描述
    Link used to describe the link to the upgrade guide
    类型
    object
    属性类型描述
    titlestring

    Title is the title of the link

    urlstring

    URL is the url of the link

    .status.conditions

    类型
    array

    .status.conditions[]

    类型
    object
    必填
    statustype
    属性类型描述
    lastTransitionTimestring
    messagestring
    reasonstring
    statusboolean
    typestring

    .status.dependency_secrets

    类型
    array

    .status.dependency_secrets[]

    类型
    string

    .status.deployedRelease

    类型
    object
    必填
    manifestname
    属性类型描述
    manifeststring
    namestring

    .status.helmValues

    描述
    record helm values
    类型
    object

    API 端点

    可用的 API 端点如下：

    • /apis/operator.alaudadevops.io/v1alpha1/namespaces/{namespace}/sonarqubes
      • DELETE: delete collection of Sonarqube
      • GET: list objects of kind Sonarqube
      • POST: create a new Sonarqube
    • /apis/operator.alaudadevops.io/v1alpha1/namespaces/{namespace}/sonarqubes/{name}
      • DELETE: delete the specified Sonarqube
      • GET: read the specified Sonarqube
      • PATCH: partially update the specified Sonarqube
      • PUT: replace the specified Sonarqube
    • /apis/operator.alaudadevops.io/v1alpha1/namespaces/{namespace}/sonarqubes/{name}/status
      • GET: read status of the specified Sonarqube
      • PATCH: partially update status of the specified Sonarqube
      • PUT: replace status of the specified Sonarqube

    /apis/operator.alaudadevops.io/v1alpha1/namespaces/{namespace}/sonarqubes

    HTTP 方法
    DELETE
    描述
    delete collection of Sonarqube
    HTTP 响应
    HTTP 状态码响应体
    200 - OKStatus schema
    401 - UnauthorizedEmpty
    HTTP 方法
    GET
    描述
    list objects of kind Sonarqube
    HTTP 响应
    HTTP 状态码响应体
    200 - OKSonarqubeList schema
    401 - UnauthorizedEmpty
    HTTP 方法
    POST
    描述
    create a new Sonarqube
    查询参数
    参数类型描述
    dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
    fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
    请求体参数
    参数类型描述
    bodySonarqube schemaapplication/json formatted
    HTTP 响应
    HTTP 状态码响应体
    200 - OKSonarqube schema
    201 - CreatedSonarqube schema
    202 - AcceptedSonarqube schema
    401 - UnauthorizedEmpty

    /apis/operator.alaudadevops.io/v1alpha1/namespaces/{namespace}/sonarqubes/{name}

    HTTP 方法
    DELETE
    描述
    delete the specified Sonarqube
    查询参数
    参数类型描述
    dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
    HTTP 响应
    HTTP 状态码响应体
    200 - OKStatus schema
    202 - AcceptedStatus schema
    401 - UnauthorizedEmpty
    HTTP 方法
    GET
    描述
    read the specified Sonarqube
    HTTP 响应
    HTTP 状态码响应体
    200 - OKSonarqube schema
    401 - UnauthorizedEmpty
    HTTP 方法
    PATCH
    描述
    partially update the specified Sonarqube
    查询参数
    参数类型描述
    dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
    fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
    HTTP 响应
    HTTP 状态码响应体
    200 - OKSonarqube schema
    401 - UnauthorizedEmpty
    HTTP 方法
    PUT
    描述
    replace the specified Sonarqube
    查询参数
    参数类型描述
    dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
    fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
    请求体参数
    参数类型描述
    bodySonarqube schemaapplication/json formatted
    HTTP 响应
    HTTP 状态码响应体
    200 - OKSonarqube schema
    201 - CreatedSonarqube schema
    401 - UnauthorizedEmpty

    /apis/operator.alaudadevops.io/v1alpha1/namespaces/{namespace}/sonarqubes/{name}/status

    HTTP 方法
    GET
    描述
    read status of the specified Sonarqube
    HTTP 响应
    HTTP 状态码响应体
    200 - OKSonarqube schema
    401 - UnauthorizedEmpty
    HTTP 方法
    PATCH
    描述
    partially update status of the specified Sonarqube
    查询参数
    参数类型描述
    dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
    fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
    HTTP 响应
    HTTP 状态码响应体
    200 - OKSonarqube schema
    401 - UnauthorizedEmpty
    HTTP 方法
    PUT
    描述
    replace status of the specified Sonarqube
    查询参数
    参数类型描述
    dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
    fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
    请求体参数
    参数类型描述
    bodySonarqube schemaapplication/json formatted
    HTTP 响应
    HTTP 状态码响应体
    200 - OKSonarqube schema
    201 - CreatedSonarqube schema
    401 - UnauthorizedEmpty